Documentation about Study Configurator#32
Conversation
📝 WalkthroughWalkthroughThis PR adds a Study Configurator docs section: five new MDX pages (starting-page, configurator-overview, surveys, rules, settings), updates Changes
Sequence Diagram(s)(Skipped — documentation-only changes; no runtime control-flow introduced.) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📜 Recent review detailsConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🔇 Additional comments (5)
✏️ Tip: You can disable this entire section by setting Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@content/docs/study-configurator/rules.mdx`:
- Around line 12-23: The "Study Rules Editor" link at the top is pointing to the
wrong URL (/docs/study-rules-editor/basics/study-rules); update the anchor
target for the "Study Rules Editor" text to
/docs/study-rules-editor/basics/editor-overview so it points to the editor
overview (match the correct link used later in the file).
🧹 Nitpick comments (4)
content/docs/study-configurator/starting-page.mdx (1)
28-31: Consider clarifying the toggle description.The toggle label "System default study (inactive)" combined with the description could be slightly confusing. It's unclear if "(inactive)" is part of the UI label or indicates the toggle's default state. Consider rephrasing for clarity, e.g., separating the UI label from the behavior description.
content/docs/study-configurator/settings.mdx (1)
105-107: Anchor link is correct but relies on heading numbering.The anchor
#6-notify-researchers-emailcorrectly references the heading#### 6. **Notify researchers (Email)**in the study-rules documentation. However, using numbered headings for anchors is inherently fragile—if the action order changes, the link will break silently. Consider using a permanent anchor ID (e.g.,{#notify-researchers-email}) to make the reference more robust.content/docs/study-configurator/configurator-overview.mdx (1)
1-52: Documentation structure looks good.The page provides a clear overview of the Study Configurator dashboard with well-organized sections covering navigation, header, overview cards, surveys, and language settings. Internal links properly reference sibling documentation pages being added in this PR.
Minor formatting nit: There are extra consecutive blank lines at lines 33-34 and 47-48 that could be cleaned up for consistency.
content/docs/study-configurator/study-variables.mdx (1)
42-44: Consider formatting phase identifiers as code.The static analysis flagged
phase1andphase2as potential spelling issues. While these are clearly intentional example identifiers, wrapping them in backticks would clarify they are code/identifiers and silence the linter:✏️ Optional formatting improvement
-- **Category:** Choose from a dropdown to change the study flow (e.g., phase1 -> phase2, with different behavior for each phase). +- **Category:** Choose from a dropdown to change the study flow (e.g., `phase1` -> `phase2`, with different behavior for each phase).
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (24)
content/docs/study-configurator/images/access.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/advanced.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/code-lists1.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/code-lists2.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/create-study.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/display-texts.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/import-export.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/importer-study-config2.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/language-toggle.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/notifications.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/notifications2.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/overview-cards.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/rules-workspace.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/settings-general.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/starting-page.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/study-card-preview.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/study-conf-overview.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/study-header.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/study-status.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/survey-version-options.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/surveys-overview.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/surveys-workspace1.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/surveys-workspace2.pngis excluded by!**/*.pngcontent/docs/study-configurator/images/top-navigation-bar.pngis excluded by!**/*.png
📒 Files selected for processing (7)
content/docs/study-configurator/configurator-overview.mdxcontent/docs/study-configurator/meta.jsoncontent/docs/study-configurator/rules.mdxcontent/docs/study-configurator/settings.mdxcontent/docs/study-configurator/starting-page.mdxcontent/docs/study-configurator/study-variables.mdxcontent/docs/study-configurator/surveys.mdx
🧰 Additional context used
🪛 LanguageTool
content/docs/study-configurator/study-variables.mdx
[grammar] ~43-~43: Ensure spelling is correct
Context: ...ropdown to change the study flow (e.g., phase1 -> phase2, with different behavior for ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~43-~43: Ensure spelling is correct
Context: ... change the study flow (e.g., phase1 -> phase2, with different behavior for each phase...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (6)
content/docs/study-configurator/meta.json (1)
1-14: LGTM!The navigation structure is well-organized with a logical flow from getting started through to settings. The pages array correctly references all the new documentation pages introduced in this PR.
content/docs/study-configurator/surveys.mdx (1)
1-70: Well-structured documentation for the Surveys Workspace.The content comprehensively covers the interface layout, survey creation options, detail view, and version management. The callout about single-version publishing is a helpful clarification for users.
content/docs/study-configurator/settings.mdx (1)
1-230: Comprehensive and well-structured settings documentation.Excellent use of fumadocs-ui components (
Steps,ImageZoom,Callout) to enhance readability. The documentation thoroughly covers all settings categories with appropriate warnings for destructive actions in the Advanced section.content/docs/study-configurator/study-variables.mdx (3)
19-39: Clear and comprehensive introduction to Study Variables.The documentation effectively explains what study variables are, their purpose, value types, and provides practical use cases. The distinction from participant flags (individual vs. global) is helpful context.
125-165: Well-documented Study Counters section.The new Study Counters section is a valuable addition that clearly explains:
- What counters are and their properties (via TypeTable)
- Practical use cases (event counting, participant tracking)
- Management operations with appropriate warnings about the impact of value changes
The cross-references to study rules documentation for counter operations are helpful.
40-45: No action needed. TheExampleBoxcomponent is properly configured as a global component inmdx-components.tsx(line 25), making it available to all MDX files without requiring explicit imports. This is the correct implementation pattern for fumadocs.
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@content/docs/study-configurator/study-variables.mdx`:
- Line 129: Update the two anchor links in the study-variables document so they
follow the repository's anchor format (no leading slash before the #): replace
the link text
"/docs/study-rules-editor/basics/study-rules/#4-increment-and-get-study-counter-value"
with
"/docs/study-rules-editor/basics/study-rules#4-increment-and-get-study-counter-value"
and similarly replace
"/docs/study-rules-editor/basics/study-rules/#3-get-current-study-counter-value"
with
"/docs/study-rules-editor/basics/study-rules#3-get-current-study-counter-value"
so both anchors in the content for the study counter descriptions use the
correct "#"-style anchors.
In `@content/docs/study-rules-editor/basics/study-rules.mdx`:
- Line 575: This file contains a duplicate HTML anchor id
"notify-researchers-email" which breaks in-page linking; locate both occurrences
(the <a id="notify-researchers-email"> anchors) and rename them to unique ids
(for example "notify-researchers-email-basics" and
"notify-researchers-email-advanced" or suffix with the section name), then
update any internal links or references that target "#notify-researchers-email"
to the new ids so fragment navigation remains correct.
🧹 Nitpick comments (1)
content/docs/study-configurator/study-variables.mdx (1)
115-121: Consider simplifying header formatting.The
####markdown header syntax combined with**bold**is redundant—headers are already emphasized. Using just####would be cleaner and more consistent with the other headings in this document.📝 Suggested fix
-#### **Study rules/study actions** (server-side): +#### Study rules/study actions (server-side) - expressions: retrieve and use the value of the study variable in a condition or as a parameter of an expression - available study expressions: [conditional expressions](/docs/study-rules-editor/basics/study-rules#study-bool-study-variables) or [numerical](/docs/study-rules-editor/basics/study-rules#study-int-study-variables) and [text](/docs/study-rules-editor/basics/study-rules#study-string-study-variables) expressions. - actions: [update](/docs/study-rules-editor/basics/study-rules#study-update-study-variables) the value of the study variable -#### **Survey conditions** (client-side): +#### Survey conditions (client-side) - expressions: retrieve and use the value of the study variable in the condition - available survey expressions: [conditional expressions](/docs/survey-editor/basics/conditions#survey-bool-study-variables) or [numerical and text expressions](/docs/survey-editor/basics/conditions#survey-num-study-variables).
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
content/docs/study-configurator/configurator-overview.mdxcontent/docs/study-configurator/rules.mdxcontent/docs/study-configurator/settings.mdxcontent/docs/study-configurator/study-variables.mdxcontent/docs/study-rules-editor/basics/study-rules.mdx
🚧 Files skipped from review as they are similar to previous changes (3)
- content/docs/study-configurator/configurator-overview.mdx
- content/docs/study-configurator/settings.mdx
- content/docs/study-configurator/rules.mdx
🔇 Additional comments (1)
content/docs/study-configurator/study-variables.mdx (1)
17-165: Well-structured documentation combining Study Variables and Counters.The documentation effectively merges Study Variables and Study Counters into a unified narrative. The progression from definitions to management to usage is logical, and the use cases provide helpful context. The warnings about counter modifications (lines 160-161) are particularly valuable for administrators.
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@content/docs/study-configurator/study-variables.mdx`:
- Around line 115-121: Remove the leading 4-space indentation before the bullet
lines under the "Study rules/study actions (server-side):" and "Survey
conditions (client-side):" headings in study-variables.mdx so they render as
normal Markdown lists instead of code blocks; locate the blocks starting with
"#### Study rules/study actions (server-side):" and "#### Survey conditions
(client-side):", strip the extra indentation from the list items (the lines
beginning with "- expressions:" and subsequent "-" items) so they align directly
under the headings.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
content/docs/study-configurator/settings.mdxcontent/docs/study-configurator/study-variables.mdxcontent/docs/study-rules-editor/basics/study-rules.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
- content/docs/study-configurator/settings.mdx
- content/docs/study-rules-editor/basics/study-rules.mdx
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
2 participants
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.